Oracle^® Hospitality OPERA Web Self-Service

Header Web Service Specification

Version 5.1

September 2017

Copyright © 1987, 2017, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface. 4

Audience. 4

Customer Support. 4

Documentation.. 4

Revision History. 4

1 Header – Messaging Specifications 5

Header. 5

OGHeader. 5

EndPoint. 8

SystemID.. 8

EndPointList. 9

Authentication.. 9

UserCredentials. 10

Licence. 12

Preface

The objective of this document is to depict how the Header Web Service messages function in OPERA Web Suite (OWS).

This document may not contain all the web service messages supported by OWS.

Audience

This document is intended for those developing custom applications that interact with Header functionality in OWS.

Customer Support

To contact Oracle Customer Support, access My Oracle Support at the following URL:

https://support.oracle.com

When contacting Customer Support, please provide the following:

· Product version and program/module name

· Functional and technical description of the problem (include business impact)

· Detailed step-by-step instructions to re-create

· Exact error message received and any associated log files

· Screenshots of each step you take

Documentation

Oracle Hospitality product documentation is available on the Oracle Help Center at http://docs.oracle.com/en/industries/hospitality/

Revision History

Date	Description of Change
August 2005	· Initial publication
September 2006	· Revised and edited
February 2007	· Edited
December 2007	· Edited
December 2013	· Updated with information for terminalID attribute
September 2017	· Rebrand and update document format

1 Header – Messaging Specifications

Header

<?xml version="1.0" encoding="UTF-8"?>

<soap:Header>

<OGHeader transactionID="000032" terminalID=" LoginTest " timeStamp="2004-01-09T09:55:16.3618750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

<Origin entityID="WEST" systemType="WEB"/>

<Destination entityID="WC" systemType="ORS"/>

<Intermediaries>

<EndPoint systemType="DX"/>

<EndPoint systemType="WEB"/>

</Intermediaries>

<Authentication>

<UserCredentials>

<UserName> USERNAME_EXAMPLE</UserName>

<UserPassword>I USERPASS_EXAMPLE</UserPassword>

<Domain>HOTEL</Domain>

<SecurityId>165668</SecurityId>

</UserCredentials>

<Licence>

<Key>X1XXX1XXRX1XX</Key>

</Licence>

</Authentication>

</OGHeader>

</soap:Header>

<xs:element name="OGHeader" type="tns:OGHeader">

<xs:annotation>

<xs:documentation xml:lang="en">The header values as sent in a SOAP message for all request to the web service.</xs:documentation>

</xs:annotation>

</xs:element>

Name	Type	Data Type	Use	Comments
OGHeader	element	OGHeader	required	The header values, sent as a SOAP header element in the message.

OGHeader

<xs:complexType name="OGHeader">

<xs:sequence>

<xs:element name="Origin" type="tns:EndPoint"/>

<xs:element name="Destination" type="tns:EndPoint"/>

<xs:element name="Intermediaries" type="tns:EndPointList" minOccurs="0"/>

<xs:element name="Authentication" minOccurs="0">

<xs:annotation>

<xs:documentation xml:lang="en">Authentication element that is used to identify who the caller is and if they are allowed to call the web service. This element is optional as it is only used when the web service is running in secure mode.</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="UserCredentials">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">User Name of the person requesting to use the application. They can make a booking on behalf of anyone else.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="UserPassword" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Password that is used to authenticate the user and is as provided by Opera.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Domain" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Domain identifies the user as to what Authentication platform they belong to. The default is OPERA and has been added to allow for the possibility of Federated Authentication at a later stage.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="SecurityId" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="Licence" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="Key" minOccurs="0">

<xs:annotation>

<xs:documentation xml:lang="en">The key will be in the form of a GUID and is used to check if the user calling the web service is really authorized to do so or not. The key is issued by OPERA application.</xs:documentation>

</xs:annotation>

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:pattern value="\{[\dA-Fa-f]{8}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{12}\}"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name="transactionID" type="xs:string"/>

<xs:attribute name="authToken" type="xs:string"/>

<xs:attribute name="terminalID" type="xs:string" use="optional"/>

<xs:attribute name="timeStamp" type="xs:dateTime"/>

<xs:attribute name="primaryLangID" use="optional" default="E">

<xs:annotation>

<xs:documentation xml:lang="en">Identifies the primary language preference for the message. The human language is identified by ISO 639 codes.</xs:documentation>

</xs:annotation>

<xs:simpleType>

<xs:restriction base="xs:string"/>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

Name	Type	Data Type	Use	Comments
Origin	element	EndPoint	required	The system that the message originated from (mapped as the channel code).
Destination	element	EndPoint	required	The system that the message will be returned to.
Intermediaries	element	EndPointList	optional	The additional systems that the message will be processed in.
Authentication	element	Authentication	optional	The message authentication details.
transactionID	attribute	string	required	The unique message identification number.
authToken	attribute	string	optional	An authenticated token for the current message.
terminalID	attribute	string	optional	The ID of the Workstation from which the message is generated.
timeStamp	attribute	string	required	The time stamp for the current message.
primaryLangID	attribute	string	optional	The language that the response message will be displayed in. If not specified, the default language is E (English). If passed in the request, the translated text in that language will be returned in the response.

EndPoint

<xs:complexType name="EndPoint">

<xs:complexContent>

<xs:extension base="tns:SystemID">

<xs:attribute name="systemType" type="xs:string"/>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Name	Type	Data Type	Use	Comments
SystemID	element	SystemID	required	The host system identification number.
systemType	attribute	string	required	The type of host system. It can be some of the predefined values, such as ADS, WEB, GDS, ORS, or PMS.

SystemID

<xs:complexType name="SystemID">

<xs:attribute name="entityID" type="xs:string" use="required"/>

<xs:attribute name="organizationID" type="xs:string"/>

</xs:complexType>

Name	Type	Data Type	Use	Comments
entityID	attribute	string	required	The host system channel name that is configured in the system.
organizationID	attribute	string	optional	Not used in this context.

EndPointList

<xs:complexType name="EndPointList">

<xs:sequence>

<xs:element name="EndPoint" type="tns:EndPoint" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
EndPoint	element	EndPoint	required	A list of intermediary systems.

Authentication

<xs:element name="Authentication" minOccurs="0">

<xs:annotation>

<xs:documentation xml:lang="en">Authentication element that is used to identify who the caller is and if they are allowed to call the web service. This element is optional as it is only used when the web service is running in secure mode.</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="UserCredentials">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">User Name of the person requesting to use the application. They can make a booking on behalf of anyone else.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="UserPassword" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Password that is used to authenticate the user and is as provided by OPERA.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Domain" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Domain identifies the user as to what Authentication platform they belong to. The default is OPERA and has been added to allow for the possibility of Federated Authentication at a later stage.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="SecurityId" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="Licence" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="Key" minOccurs="0">

<xs:annotation>

<xs:documentation xml:lang="en">The key will be in the form of a GUID and is used to check if the user calling the web service is really authorized to do so or not. The key is issued by OPERA application.</xs:documentation>

</xs:annotation>

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:pattern value="\{[\dA-Fa-f]{8}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{12}\}"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

Name	Type	Data Type	Use	Comments
UserCredentials	element	complexType	required	An authentication element that is used to identify who the caller is, and what rights are set in order to use the Web Service.
Licence	element	complexType	required	A session based license key.

UserCredentials

<xs:element name="UserCredentials">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">User Name of the person requesting to use the application. They can make a booking on behalf of anyone else.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="UserPassword" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Password that is used to authenticate the user and is as provided by Opera.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Domain" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">Domain identifies the user as to what Authentication platform they belong to. The default is OPERA and has been added to allow for the possibility of Federated Authentication at a later stage.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="SecurityId" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

</xs:element>

Name	Type	Data Type	Use	Comments
UserName	element	string	required	The user name of the individual, company or travel agency requesting to use the application, including rights to make a booking on behalf of anyone else.
UserPassword	element	string	required	The password that is used to authenticate the user, as provided by Opera.
Domain	element	string	required	The domain that identifies the user as to what authentication platform they belong to. The default is OPERA.
SecurityId	element	string	required	The name ID of the individual, company or travel agency used to identify the user rights. The security ID is issued by a call to a Security Web Service.

Licence

<xs:element name="Licence" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="Key" minOccurs="0">

<xs:annotation>

<xs:documentation xml:lang="en">The key will be in the form of a GUID and is used to check if the user calling the web service is really authorized to do so or not. The key is issued by OPERA application.</xs:documentation>

</xs:annotation>

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:pattern value="\{[\dA-Fa-f]{8}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{4}\-[\dA-Fa-f]{12}\}"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

Name	Type	Data Type	Use	Comments
Key	element	string	required	A session key issued by the system that is used to check if the user calling the Web Service is really authorized to do so or not. The license key is issued by a call to a Security Web Service.